<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Jumper documentation</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Jumper (v1.8.0)</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Tables">Tables</a></li>
</ul>


<h2>Modules</h2>
<ul>
  <li><a href="../modules/jumper.core.bheap.html">jumper.core.bheap</a></li>
  <li><a href="../modules/jumper.core.heuristics.html">jumper.core.heuristics</a></li>
  <li><a href="../modules/jumper.core.node.html">jumper.core.node</a></li>
  <li><strong>jumper.core.path</strong></li>
  <li><a href="../modules/jumper.grid.html">jumper.grid</a></li>
  <li><a href="../modules/jumper.pathfinder.html">jumper.pathfinder</a></li>
</ul>
<h2>Scripts</h2>
<ul>
  <li><a href="../scripts/jumper.search.astar.html">jumper.search.astar</a></li>
  <li><a href="../scripts/jumper.search.bfs.html">jumper.search.bfs</a></li>
  <li><a href="../scripts/jumper.search.dfs.html">jumper.search.dfs</a></li>
  <li><a href="../scripts/jumper.search.dijkstra.html">jumper.search.dijkstra</a></li>
  <li><a href="../scripts/jumper.search.jps.html">jumper.search.jps</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>jumper.core.path</code></h1>

<p><strong>The <code>path</code> class</strong>.</p>
<p> The <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  class represents a path from a <code>start</code> location to a <code>goal</code>.
 An instance from this class would be a result of a request addressed to <code>pathfinder:getPath</code>.
 A <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  is basically a set of <code>nodes</code>, aligned in a specific order, defining a way to follow for moving agents.
 </p>
    <h3>Info:</h3>
    <ul>
        <li><strong>Copyright</strong>: 2012-2013</li>
        <li><strong>License</strong>: <a href="http://www.opensource.org/licenses/mit-license.php">MIT</a></li>
        <li><strong>Author</strong>: Roland Yonaba</li>
    </ul>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#path:new">path:new&nbsp;()</a></td>
	<td class="summary">Inits a new <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  object.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#path:iter">path:iter&nbsp;()</a></td>
	<td class="summary">Iterates on each single <a href="../modules/jumper.core.path.html#jumper.core.node">node</a>  along a <a href="../modules/jumper.core.path.html#jumper.core.path">path</a> .</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#path:getLength">path:getLength&nbsp;()</a></td>
	<td class="summary">Evaluates the <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  length</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#path:fill">path:fill&nbsp;()</a></td>
	<td class="summary">Path filling function.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#path:filter">path:filter&nbsp;()</a></td>
	<td class="summary">Path compression.</td>
	</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#path">path</a></td>
	<td class="summary">The <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  class</td>
	</tr>
</table>

<br/>
<br/>


    <h2><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "path:new"></a>
    <strong>path:new&nbsp;()</strong>
    </dt>
    <dd>
    Inits a new <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  object.


    <h3>Returns:</h3>
    <ol>

          <span class="types"><a class="type" href="../modules/jumper.core.path.html#jumper.core.path">path</a></span>
        a <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  object
    </ol>




</dd>
    <dt>
    <a name = "path:iter"></a>
    <strong>path:iter&nbsp;()</strong>
    </dt>
    <dd>
    Iterates on each single <a href="../modules/jumper.core.path.html#jumper.core.node">node</a>  along a <a href="../modules/jumper.core.path.html#jumper.core.path">path</a> .  At each step of iteration,
 returns a <a href="../modules/jumper.core.path.html#jumper.core.node">node</a>  and plus a count value.


    <h3>Returns:</h3>
    <ol>
        <li>
          <span class="types"><a class="type" href="../modules/jumper.core.path.html#jumper.core.node">node</a></span>
        a <a href="../modules/jumper.core.path.html#jumper.core.node">node</a> </li>
        <li>
          <span class="types"><span class="type">int</span></span>
        the count for the number of nodes</li>
    </ol>




</dd>
    <dt>
    <a name = "path:getLength"></a>
    <strong>path:getLength&nbsp;()</strong>
    </dt>
    <dd>
    Evaluates the <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  length


    <h3>Returns:</h3>
    <ol>

          <span class="types"><span class="type">number</span></span>
        the <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  length
    </ol>




</dd>
    <dt>
    <a name = "path:fill"></a>
    <strong>path:fill&nbsp;()</strong>
    </dt>
    <dd>
    Path filling function.  Interpolates between non contiguous locations along a <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>
 to build a fully continuous <a href="../modules/jumper.core.path.html#jumper.core.path">path</a> . This maybe useful when using <code>Jump Point Search</code> finder.
 Does the opposite of <a href="../modules/jumper.core.path.html#path:filter">path:filter</a>




    <h3>see also:</h3>
    <ul>
         <a href="../modules/jumper.core.path.html#path:filter">path:filter</a>
    </ul>


</dd>
    <dt>
    <a name = "path:filter"></a>
    <strong>path:filter&nbsp;()</strong>
    </dt>
    <dd>
    Path compression.  Given a <a href="../modules/jumper.core.path.html#jumper.core.path">path</a> , eliminates useless nodes to return a lighter <a href="../modules/jumper.core.path.html#jumper.core.path">path</a> . Does
 the opposite of <a href="../modules/jumper.core.path.html#path:fill">path:fill</a>




    <h3>see also:</h3>
    <ul>
         <a href="../modules/jumper.core.path.html#path:fill">path:fill</a>
    </ul>


</dd>
</dl>
    <h2><a name="Tables"></a>Tables</h2>

    <dl class="function">
    <dt>
    <a name = "path"></a>
    <strong>path</strong>
    </dt>
    <dd>
    The <a href="../modules/jumper.core.path.html#jumper.core.path">path</a>  class






</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.3</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
